docs: require a version bump and dated CHANGELOG entry in every PR - #532
Merged
rickdijk merged 1 commit intoSep 23, 2026
Conversation
Replaces the [Unreleased] + release-PR model in AGENTS.md, CONTRIBUTING.md and the PR template with a version bump per PR, so releasing is tagging. Docs-only and CI-only PRs do not bump. Also fixes a doubled bullet in the 3.4.5 CHANGELOG entry. Co-Authored-By: Claude <noreply@anthropic.com>
rickdijk
deleted the
rick/fpl-35-flutter_cache_manager-document-a-version-bump-in-every-pr
branch
September 23, 2026 17:35
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✨ What kind of change does this PR introduce? (Bug fix, feature, docs update...)
Docs update.
AGENTS.md,CONTRIBUTING.mdand the PR template tell contributors to add entries under## [Unreleased]and leave versioning to a separate maintainer release PR. In practice every release since 3.4.3 has been a version bump per PR, so contributors following the docs write entries that maintainers then rewrite.🆕 What is the new behavior (if this is a feature change)?
The docs match practice and the flutter_cached_network_image wording: every PR bumps its package's
version:following semver and adds a matching## [x.y.z] - YYYY-MM-DDCHANGELOG entry dated the day the PR opens. Releasing is tagging the merge commit onmain; there is no release-prep PR and no[Unreleased]section. Docs-only and CI-only PRs do not bump. The PR template gains a "Version bumped and dated CHANGELOG entry added" item, and a doubled bullet in the 3.4.5 CHANGELOG entry is fixed.💥 Does this PR introduce a breaking change?
No
🐛 Recommendations for testing
Markdown only, so format/analyze/tests were not run locally; check that CI stays green.
📝 Links to relevant issues/docs
🤔 Checklist before submitting
🤖 Generated with Claude Code